Class FileReflection

Summary

Fully Qualified Name: Laminas\Code\Reflection\FileReflection
Implements: ReflectionInterface

Description

Methods

Name Description Defined By
__construct() FileReflection
__toString() Serialize to string FileReflection
export() Required by the Reflector interface. FileReflection
getClass() Retrieve the reflection class of a given class found in this file FileReflection
getClasses() Return the reflection classes of the classes found inside this file FileReflection
getContents() Return the full contents of file FileReflection
getDocBlock() FileReflection
getDocComment() FileReflection
getEndLine() Get the end line / number of lines FileReflection
getFileName() Return the file name of the reflected file FileReflection
getFunctions() Return the reflection functions of the functions found inside this file FileReflection
getNamespace() FileReflection
getNamespaces() FileReflection
getStartLine() Get the start line - Always 1, staying consistent with the Reflection API FileReflection
getUses() FileReflection
toString() FileReflection

Method Details

__construct()

Parameter Name Type Description
$filename string
$includeIfNotAlreadyIncluded bool

Returns:

__toString()

Serialize to string

Required by the Reflector interface

Returns: string

export()

Required by the Reflector interface.

Returns: void

getClass()

Retrieve the reflection class of a given class found in this file

Parameter Name Type Description
$name null|string

Returns: \ClassReflection

getClasses()

Return the reflection classes of the classes found inside this file

Returns: \ClassReflection[]

getContents()

Return the full contents of file

Returns: string

getDocBlock()

Returns: \DocBlockReflection|bool

getDocComment()

Returns: string

getEndLine()

Get the end line / number of lines

Returns: int

getFileName()

Return the file name of the reflected file

Returns: string

getFunctions()

Return the reflection functions of the functions found inside this file

Returns: \FunctionReflection[]

getNamespace()

Returns: null|string

getNamespaces()

Returns: string[]

getStartLine()

Get the start line - Always 1, staying consistent with the Reflection API

Returns: int

getUses()

Returns: array

toString()

Returns: void

Top